Skip to main content

Sage

Prerequisites for Configuring Sage Data Source​

Account Requirements​

  • Active Sage account
  • Admin-level access
  • API credentials (Client ID and Client Secret)
  • Sage API endpoint (e.g., https://api.sage.com)
  • Required permissions for financials, transactions, and reporting

Obtaining Authentication Credentials​

1. Account ID (Realm)​

  • Obtained during OAuth authentication process
  • Tied to the Sage application you are connecting with

2. Client ID and Client Secret​

  1. Log in to Sage Developer Portal
  2. Create a New Integration App:
    • Go to My Apps or Applications
    • Click Create Application
    • Provide app name and details
    • Set OAuth Redirect URI
  3. Set required permissions/scopes
  4. Copy provided Client ID and Client Secret

3. Access Token​

Request Authorization Code​

https://api.sage.com/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI

Exchange Authorization Code​

curl -X POST -d "grant_type=authorization_code&code=AUTHORIZATION_CODE&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&redirect_uri=YOUR_REDIRECT_URI" https://api.sage.com/oauth/token

4. Refresh Token​

Use to generate new Access Token when expired:

curl -X POST -d "grant_type=refresh_token&refresh_token=YOUR_REFRESH_TOKEN&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET" https://api.sage.com/oauth/token

Configuring Sage Data Source​

  1. Select the Source Type as Sage

  2. Fill in the required details:

Basic Configuration​

  • Account ID: Your Sage Account ID
  • Client ID: Enter the Client ID from integration app
  • Client Secret: Enter the Client Secret from integration app
  • API Endpoint: Specify the Sage API endpoint
  • Access Token: Enter the generated Access Token

Additional Configuration​

  • Start Date: Format: YYYY-MM-DD
    • All data created after this date will be replicated
  • End Date (Optional): Format: YYYY-MM-DD
    • If blank, data from Start Date onward will be synced

Data Replication Options​

  • Replicate Financial Data: Toggle for accounts, ledgers, and transactions
  • Replicate Inventory Data: Toggle for products, stock, and pricing
  • Replicate Customer Data: Toggle for customer profiles and billing information
  • Include Historical Data: Toggle for data prior to Start Date
  1. Click on Test Connection to verify if the connection is established successfully.